xml/Microsoft.Azure.Documents.Client/DocumentResponse`1.xml (55 lines of code) (raw):
<Type Name="DocumentResponse<TDocument>" FullName="Microsoft.Azure.Documents.Client.DocumentResponse<TDocument>">
<TypeSignature Language="C#" Value="public sealed class DocumentResponse<TDocument> : Microsoft.Azure.Documents.Client.ResourceResponseBase, Microsoft.Azure.Documents.Client.IDocumentResponse<TDocument>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit DocumentResponse`1<TDocument> extends Microsoft.Azure.Documents.Client.ResourceResponseBase implements class Microsoft.Azure.Documents.Client.IDocumentResponse`1<!TDocument>, class Microsoft.Azure.Documents.Client.IResourceResponseBase" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Client.DocumentResponse`1" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class DocumentResponse(Of TDocument)
Inherits ResourceResponseBase
Implements IDocumentResponse(Of TDocument)" />
<TypeSignature Language="F#" Value="type DocumentResponse<'Document> = class
 inherit ResourceResponseBase
 interface IDocumentResponse<'Document>
 interface IResourceResponseBase" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.14.1.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.16.2.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.14.1.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.16.2.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TDocument" />
</TypeParameters>
<Base>
<BaseTypeName>Microsoft.Azure.Documents.Client.ResourceResponseBase</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.Documents.Client.IDocumentResponse<TDocument></InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.Azure.Documents.Client.IResourceResponseBase</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<typeparam name="TDocument">the document type.</typeparam>
<summary>
Represents the template class used by methods returning single objects in the Azure Cosmos DB service.
</summary>
<remarks>
Response from type-specific read of Document resource(ReadDocumentAsync{TDocument}) returns the response wrapped in a
DocumentResponse object. This contains the metadata from the response headers from the Azure Cosmos DB call including
the request units (RequestCharge), activity ID, quotas/usage of resources and the typed document object(TDocument).
</remarks>
<example>
The following example extracts the CustomerName property, request units consumed, activity ID and StatusCode from a ReadDocumentAsync{Customer} call.
<code language="c#"><![CDATA[
DocumentResponse<Customer> response = await client.ReadDocumentAsync<Customer>(documentLink);
Console.WriteLine(response.Document.CustomerName);
Console.WriteLine(response.RequestCharge);
Console.WriteLine(response.ActivityId);
Console.WriteLine(response.StatusCode); // HttpStatusCode.Created or 201
]]></code></example>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentResponse ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Client.DocumentResponse`1.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Constructor exposed for mocking purposes for the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentResponse (TDocument document);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(!TDocument document) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Client.DocumentResponse`1.#ctor(`0)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (document As TDocument)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Documents.Client.DocumentResponse<'Document> : 'Document -> Microsoft.Azure.Documents.Client.DocumentResponse<'Document>" Usage="new Microsoft.Azure.Documents.Client.DocumentResponse<'Document> document" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="document" Type="TDocument" />
</Parameters>
<Docs>
<param name="document" />
<summary>
Constructor exposed for mocking purposes for the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Document">
<MemberSignature Language="C#" Value="public TDocument Document { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance !TDocument Document" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.DocumentResponse`1.Document" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Document As TDocument" />
<MemberSignature Language="F#" Value="member this.Document : 'Document" Usage="Microsoft.Azure.Documents.Client.DocumentResponse<'Document>.Document" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Azure.Documents.Client.IDocumentResponse`1.Document</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TDocument</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the document returned in the response from the Azure Cosmos DB service.
</summary>
<value>
The document returned in the response.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Implicit">
<MemberSignature Language="C#" Value="public static implicit operator TDocument (Microsoft.Azure.Documents.Client.DocumentResponse<TDocument> source);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname !TDocument op_Implicit(class Microsoft.Azure.Documents.Client.DocumentResponse`1<!TDocument> source) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Client.DocumentResponse`1.op_Implicit(Microsoft.Azure.Documents.Client.DocumentResponse{`0})~`0" />
<MemberSignature Language="VB.NET" Value="Public Shared Widening Operator CType (source As DocumentResponse(Of TDocument)) As TDocument" />
<MemberSignature Language="F#" Value="static member op_Implicit : Microsoft.Azure.Documents.Client.DocumentResponse<'Document> -> 'Document" Usage="Microsoft.Azure.Documents.Client.DocumentResponse<'Document>.op_Implicit source" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TDocument</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="Microsoft.Azure.Documents.Client.DocumentResponse<TDocument>" />
</Parameters>
<Docs>
<param name="source">The DocumentResponse source.</param>
<summary>
Returns the document in the response implicitly from the Azure Cosmos DB service.
</summary>
<returns>The document object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>